Extract a Slicer / Parameter's members

Enumerates and returns the members/elements contained in a Formulation parameter - useful for building slicer lists outside of the application.

Method

/API3/analytics/getParameterElements

  • API Section: /API3/analytics
  • API Version: 3.0
  • From Release: 2023.10
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin
    • Domain Admin
    • Pro
    • Analyst
    • Viewer
    • Basic

Method Signature

Input Parameters

Name

parameterId

Type

string

Description

The parameter's system ID

Output Response

Successful Result Code

200

Response Type

Description of Response Type

The members/elements contained in a Formulation parameter

Notes

To use this function, create custom 'Lists' and 'Parameters' in the application. The resultset can then be used to drive external applications like filtering embedded content. The parameter's ID comes from the content manager inside the main client application.

Examples

Code Snippets

Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/json;charset=utf-8,text/csv,text/csv;charset=utf-8,application/xml,application/xml;charset=utf-8,text/plain,text/plain;charset=utf-8" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/analytics/getParameterElements" \
 -d ''
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.AnalyticsServiceApi;

import java.util.*;
import java.time.*;

public class AnalyticsServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AnalyticsServiceApi apiInstance = new AnalyticsServiceApi();
        // Initialize the parameterId parameter object for the call
        String parameterId = parameterId_example; // Create the input object for the operation, type: String 

        try {
            EnumerationOutput result = apiInstance.getParameterElements(parameterId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsServiceApi#getParameterElements");
            e.printStackTrace();
        }
    }
}
import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.AnalyticsServiceApi("http://Your.Server.URL")

// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");

const parameterId = parameterId_example; // {String} 

api.getParameterElements(parameterId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class getParameterElementsExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new AnalyticsServiceApi();
        // Initialize the parameterId parameter object for the call
        var parameterId = parameterId_example;  // Create the input object for the operation, type: String | 

        try {
            // Enumerates and returns the members/elements contained in a Formulation parameter - useful for building slicer lists outside of the application.
            EnumerationOutput result = apiInstance.getParameterElements(parameterId);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling AnalyticsServiceApi.getParameterElements: " + e.Message );
        }
    }
}

import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import AnalyticsServiceApi
from pprint import pprint

        
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = AnalyticsServiceApi(api_client)
    # Initialize the parameterId parameter object for the call
    parameterId = parameterId_example # String | 

    try:
        # Enumerates and returns the members/elements contained in a Formulation parameter - useful for building slicer lists outside of the application.
        api_response = api_instance.get_parameter_elements(parameterId)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AnalyticsServiceApi->getParameterElements: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AnalyticsServiceApi();
$parameterId = parameterId_example; // String | 

try {
    $result = $api_instance->getParameterElements($parameterId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsServiceApi->getParameterElements: ', $e->getMessage(), PHP_EOL;
}
?>